Renegotiation
This API allows the renegotiation and regularization of contracts based on different eligibilities, offering several campaigns for regularization and making it easy to run simulations before the agreement is confirmed. In addition, you can look up the boletos generated after the agreement is confirmed and/or cancel the renegotiation before the enrollment installment (first installment) is paid.
Eligibility
Eligibility refers to one or more methods of renegotiating and regularizing contracts in an irregular situation. Eligibilities are predefined by the internal contract management team, and there may be different types, each with specific criteria. These differences can be seen in the type and installment_agreement_type fields, which have the following values:
type:
- TOTAL: prepayment of a single contract.
- WRAP: unification of different contracts, also called bundling.
installment_agreement_type:
- Disabled: only upfront payment of the amount owed.
- OnlyVNP: only payment of past-due amounts.
- NotVNP: only prepayment of future amounts.
- All: allows all of the options above.
Since a new contract with new installments, terms, and amounts is not generated, upfront payments of the amount owed are considered only regularization; otherwise, it becomes a renegotiation. A renegotiation also offers the possibility of bundling, which is simply the unification of different contracts to further simplify the agreement with the debtor.
You can view the contracts by providing the fund through the fund_tax_id field and its respective customer represented by customer_tax_id.
// example response:
[
{
"contracts": [
{
"balance": {
"curve_value": 3111.1,
"fixed_interest_value": 653.51,
"float_interest_value": 0,
"interest_arrears_value": 3.55,
"interest_value": 0,
"iof_fee_value": 0.32,
"late_payment_value": 0,
"penalty_fee_value": 22.47,
"principal_value": 2431.25,
"spread_rate": 49.190931
},
"contract": "AUX-55335009",
"cros_contract": "0002391480/RMD_TEST_022",
"due_days": 273,
"installments": [
{
"curve_value\"": 164.23,
"fixed_interest_value\"": 7.37,
"float_interest_value\"": 0,
"has_processing_payments": false,
"installment_number\"": 1,
"interest_arrears_value\"": 0.96,
"iof_value\"": 0.05,
"is_vnp": true,
"late_payment_value\"": 0,
"maturity_date": "2022-11-30T00:00:00",
"maturity_value\"": 160,
"penalty_fee_value\"": 3.22,
"principal_value\"": 152.63,
"status": "Opened"
}
],
"name": "FIDC MT Auxilio Brasil"
}
],
"description": "Simple Reneg.",
"id": "COL_RISK_POLICY_TEST",
"installment_agreement_type": "Disabled",
"type": "TOTAL"
}
]
Campaign
A campaign represents a specific strategy for renegotiating contracts within a given eligibility. Each eligibility type can have several campaigns associated with it, offering diverse options for regularizing the contract.
For example, one campaign within a given eligibility may offer exclusive discounts, while another campaign for the same eligibility may provide differentiated payment plans.
You can view the campaigns of one or more contracts, contract[], by providing the fund through the fund_tax_id field and its respective customer represented by customer_tax_id.
// example response:
{
[
{
"affinity_score": 5,
"code": "123456",
"first_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"grace_period_flow": {
"max_value": 0,
"name": "Installment Grace Period",
"type": "Cashflow"
},
"guarantor_type": "ORIGINAL",
"installment_agreement_type": "All",
"installment_ranges": [
{
"discount_fields": [
{
"percent": 0,
"text": "Principal",
"value": "Main"
}
],
"max_installments": 1,
"min_installments": 1
}
],
"installments_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"interest_payment_type": "Original Interest",
"interest_rate": 0,
"minimum_installment_amount": 0.1,
"minimun_entry_amount": 155.56,
"name": "123456",
"payment_dates": [
"2023-08-30"
],
"payment_periodicity": null
}
]
}
Simulation
The simulation step of a renegotiation is the step in which it is actually validated whether the customer, identified by customer_tax_id, is eligible to use a given campaign available for the contract, where all amounts and fees included in the campaign, identified by campaign_code, are checked.
// example response:
{
"contracts": [
"CONTRACT-001"
],
"cros_contracts": [
"0000000000/CONTRACT_TEST_001"
],
"debt_current_values": 3100,
"debts": [
{
"channel": "fidc",
"company": {
"business_name": "BANCO BTG PACTUAL S.A.",
"id": "30306294000145"
},
"contract": "CONTRACT-001",
"cros_contract": "0000000000/CONTRACT_TEST_001",
"curve_value": 3100,
"due_date": "2022-10-07T00:00:00",
"due_days": 273,
"installments": [
{
"curve_value": 164.23,
"installment_number": 1,
"is_vnp": true,
"maturity_date": "2022-11-30T00:00:00",
"maturity_value": 160,
"principal_value": 152.63
}
],
"installments_count": 24,
"interest_value": 653.51,
"is_late": true,
"principal_value": 2431.25,
"product": "PRODUCT",
"product_description": "FIDC Product Description",
"product_type": 0,
"spread_rate": 49.190931,
"total_balance": 0,
"trade_id": "82743754",
"updated_at": "2023-07-07T00:00:00"
}
],
"eligibility": "TESTE_FIDC",
"first_payment_date": "2023-08-30",
"first_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"id": "ef1e7735-de4f-437b-af6c-3fcec6024e4c",
"input_value": 0,
"installment_options": [
{
"annual_interest_rate": 12059.314432,
"cet_rate": 100,
"current_value_discount_percentage": 0.45,
"current_value_discount_value": 14.15,
"discount_percentage": 0.83,
"installments": [
{
"amortization\"": 3122.96727565,
"balance\"": 0,
"discount\"": 26.02,
"discount_percentage\"": 0.8331819613634702,
"due_date\"": "2023-08-30T00:00:00",
"end_accrual\"": "2023-08-30T00:00:00",
"incorporated_days\"": 0,
"incorporation_flag\"": false,
"index\"": 1,
"installment_value\"": 3122.96727565,
"installment_value_with_discount\"": 3096.94727565,
"interest_value\"": 0,
"iof_value\"": 11.86727565,
"main_ticket\"": 3122.96727565,
"start_accrual\"": "2023-08-30T00:00:00"
}
],
"installments_count\"": 1,
"monthly_interest_rate\"": null,
"original_interest_rate\"": 49.190931,
"simulation_id\"": "c9076271-a5d3-482f-83b1-befec70f235f",
"total_discount_value\"": 26.02,
"total_fee_value\"": 0,
"total_interest_value\"": 0,
"total_iof_value\"": 11.86727565,
"total_value\"": 3122.96727565,
"total_value_with_discount\"": 3096.94727565
}
],
"installments_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"max_installments_count": 1,
"requested_installments": [
""
],
"requested_installments_count": 1,
"status": "OPEN"
}
Confirmation
After the simulation, you obtain the simulation_identification value, which is required to confirm the agreement, at which point the renegotiation becomes effective. In this step you can also make the prepayment by providing fields such as payment method and number of installments.
// example response:
{
"agreement_id": "2ec83742-1ed6-9374-ac14-48f57c5f5ebb",
"contract": "0002391480/RMD_TEST_022",
"due_date": "2023-08-30T00:00:00",
"offer_id": "6fd12837-42ee-42a0-ab53-e49b42f5236d",
"serial": 2800
}
Cancellation
After the agreement is confirmed, you can cancel the renegotiation by providing the agreement identifier agreement_id and the customer customer_tax_id; however, ==cancellation is only possible in cases where the enrollment installment (first installment) has not been paid.
Boletos
After the renegotiation agreement is confirmed, you can already look up the boleto generated for payment; in scenarios where more than one boleto was generated, just provide the installment number in the installment_number field.
// example response:
{
"agreement_id": "2ec83742-1ed6-9374-ac14-48f57c5f5ebb",
"bar_code": "83928394300003234890001010000000003849504938",
"base64_representation": "base64",
"due_date": "2023-09-14T00:00:00",
"installment": 1,
"offer_id": "6fd12837-42ee-42a0-ab53-e49b42f5236d"
}
Available Resources
The Renegotiation API resources are available in the API Reference.